Package com.cisco.pt.ipc.system
Interface Variable
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
VariableImpl
Information provided by the PKI file:
\class Variable
\brief Variable is the base class for variables in the VariableManager.
\example appWindow().getActiveFile().getVariableManager().getVariable(0)
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptiongetPool()Information provided by the PKI file:getType()Information provided by the PKI file:booleanInformation provided by the PKI file:name()Information provided by the PKI file:valueOfIndex(int index) Information provided by the PKI file:Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
name
String name()Information provided by the PKI file:
\brief Returns the name of the variable. \return QString, the name of the variable.- Returns:
- String Returns a String
-
valueToString
String valueToString()Information provided by the PKI file:
\brief Returns the value of the variable. \return QString, the value of the variable.- Returns:
- String Returns a String
-
valueOfIndex
Information provided by the PKI file:
\brief Returns the value of the variable at the specified index. \param index, the index of the variable of interest. \return QString, the value of the variable.- Parameters:
index- Takes in a parameter of index- Returns:
- String Returns a String
-
getPool
Pool getPool()Information provided by the PKI file:
\brief Returns the pool that this variable is associated with. \return Pool, the Pool object that this variable is associated with.- Returns:
- Pool Returns a Pool
-
isInPool
Information provided by the PKI file:
\brief Returns true if the specified value is in the pool, otherwise false. \param value, the value of interest. \return bool, true if the specified value is in the pool, otherwise false.- Parameters:
value- Takes in a parameter of value- Returns:
- boolean Returns a boolean
-
getType
VARIABLETYPE getType()Information provided by the PKI file:
\brief Returns the type of the variable. \return VARIABLETYPE, the type of the variable. Variable types: ENTIRE_RANGE = 0, RANDOM = 1, STATIC = 2, SEED = 3- Returns:
- VARIABLETYPE Returns a VARIABLETYPE
-